| Package | ihe.iti.dsubm |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | https://profiles.ihe.net/ITI/DSUBm/https://build.fhir.org/ig/IHE/ITI.DSUBm/CapabilityStatement-IHE.DSUBm.ResourceNotificationBroker.html |
| Url | https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker |
| Version | 1.0.1-current |
| Status | active |
| Date | 2023-10-27 |
| Name | IHE_DSUBm_ResourceNotificationBroker |
| Title | IHE DSUBm ResourceNotificationBroker |
| Experimental | False |
| Realm | uv |
| Authority | ihe |
| Description | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided. - Using FHIR R4 - SHALL support both json and xml encoding - SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/) - SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic - MAY support the ITI-111 transaction - SHALL support the ITI-112 transaction: - SHALL support Handshake Notification - SHOULD support Heartbeat Notification - SHALL support Event Notification - SHOULD support Subscription Deactivation Notification - SHALL support the ITI-113 transaction: - SHALL support the following [Search Parameters](ITI-113.html#23113412-message-semantics) - _id - status - url - filter-criteria - topic - SHALL support the DSUBm $status operation - SHOULD support the DSUBm $events operation - SHALL support the ITI-114 transaction: - SHALL support the following [Search Parameters](ITI-114.html#23114412-message-semantics) - code - _id - resource - derived-or-self - status - url |
| Kind | requirements |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.DSUBm.ResourceNotificationBroker
FHIR
application/fhir+xml, application/fhir+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverDSUBm Resource Notification Broker provides capability to receive subscription, receive the stream of events, receive Subscription and SubscriptionTopic Resource search
Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
transactioninteraction described as follows:https://profiles.ihe.net/ITI/MHD/StructureDefinition-IHE.MHD.Minimal.ProvideBundle.html
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Subscription | Supported Profiles Subscription for DocumentReference Patient-Dependent Subscription for DocumentReference Multi-Patient Subscription for SubmissionSet Patient-Dependent Subscription for SubmissionSet Multi-Patient | y | y | y | y | _id, status, url, filter-criteria, topic | $events, $status | ||
| Basic | y | y | code, _id, resource, derived-or-self, status, url |
read, create, update, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | string | The id of the Subscription |
| SHALL | status | token | The current state of the subscription |
| SHALL | url | uri | The URI that will receive the notifications |
| SHALL | filter-criteria | string | This SearchParameter enables query of subscriptions by filter criteria |
| SHALL | topic | uri | This SearchParameter enables query of subscriptions by canonical topic-url |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $status | The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle |
| SHOULD | $events | The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | Kind of Resource |
| SHALL | _id | string | The id of the SubscriptionTopic |
| SHALL | resource | uri | Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches. |
| SHALL | derived-or-self | uri | A server defined search that matches either the url or derivedFrom |
| SHALL | status | token | SHOULD be valued with |
| SHALL | url | uri | Logical canonical URL to reference this SubscriptionTopic (globally unique) |
clientDSUBm Resource Notification Broker provides capability to send notification
Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Bundle | Supported Profiles Event Notification Bundle Handshake Notification Bundle Heartbeat Notification Bundle Subscription Deactivation Notification Bundle |
{
"resourceType" : "CapabilityStatement",
"id" : "IHE.DSUBm.ResourceNotificationBroker",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.DSUBm.ResourceNotificationBroker</b></p><a name=\"IHE.DSUBm.ResourceNotificationBroker\"> </a><a name=\"hcIHE.DSUBm.ResourceNotificationBroker\"> </a><a name=\"IHE.DSUBm.ResourceNotificationBroker-en-US\"> </a><h2 id=\"title\">IHE DSUBm ResourceNotificationBroker</h2><ul><li>Implementation Guide Version: 1.0.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-10-27 </li><li>Published by: IHE IT Infrastructure Technical Committee </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><h3 id=\"rest1\">REST Configuration: 1 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h4></div><div class=\"panel-body\"><div><p>DSUBm Resource Notification Broker provides capability to receive subscription, receive the stream of events, receive Subscription and SubscriptionTopic Resource search</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or <a href=\"http://www.hl7.org/fhir/smart-app-launch/\">SMART-app-launch</a></p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction described as follows:<div><p>https://profiles.ihe.net/ITI/MHD/StructureDefinition-IHE.MHD.Minimal.ProvideBundle.html</p>\n</div></li></ul></div></div><h4 id=\"resourcesCap1\">Capabilities by Resource/Profile</h4><h5 id=\"resourcesSummary1\">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Subscription1-1\">Subscription</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription.html\">Subscription for DocumentReference Patient-Dependent</a><br/>��<a href=\"StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription.html\">Subscription for DocumentReference Multi-Patient</a><br/>��<a href=\"StructureDefinition-DSUBm-SubmissionSet-PatientDependent-Subscription.html\">Subscription for SubmissionSet Patient-Dependent</a><br/>��<a href=\"StructureDefinition-DSUBm-SubmissionSet-MultiPatient-Subscription.html\">Subscription for SubmissionSet Multi-Patient</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_id, status, url, filter-criteria, topic</td><td/><td/><td><code>$events</code>, <code>$status</code></td></tr><tr><td><a href=\"#Basic1-2\">Basic</a></td><td>�</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>code, _id, resource, derived-or-self, status, url</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Subscription1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Subscription</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription.html\">Subscription for DocumentReference Patient-Dependent</a><br/><a href=\"StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription.html\">Subscription for DocumentReference Multi-Patient</a><br/><a href=\"StructureDefinition-DSUBm-SubmissionSet-PatientDependent-Subscription.html\">Subscription for SubmissionSet Patient-Dependent</a><br/><a href=\"StructureDefinition-DSUBm-SubmissionSet-MultiPatient-Subscription.html\">Subscription for SubmissionSet Multi-Patient</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Resource Subscription <a href=\"ITI-110.html\">ITI-110</a> and Resource Subscription Search <a href=\"ITI-113.html\">ITI-113</a></p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>string</code></td><td><div><p>The id of the Subscription</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The current state of the subscription</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div><p>The URI that will receive the notifications</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/SearchParameter-Subscription-filter-criteria.html\">filter-criteria</a></td><td><code>string</code></td><td><div><p>This SearchParameter enables query of subscriptions by filter criteria</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/SearchParameter-Subscription-topic.html\">topic</a></td><td><code>uri</code></td><td><div><p>This SearchParameter enables query of subscriptions by canonical topic-url</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-status.html\">$status</a></td><td><div><p>The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-events.html\">$events</a></td><td><div><p>The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Basic1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Basic</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/basic.html\">Basic</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Resource SubscriptionTopic Search <a href=\"ITI-114.html\">ITI-114</a>:\nThe Resource Notification Broker Actor SHALL support the canonical instances of SubscriptionTopic presented in the DSUBm profile.\nSee <a href=\"artifacts.html#canonical-subscriptiontopic\">here</a></p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>code</td><td><code>token</code></td><td><div><p>Kind of Resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>string</code></td><td><div><p>The id of the SubscriptionTopic</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>resource</td><td><code>uri</code></td><td><div><p>Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>derived-or-self</td><td><code>uri</code></td><td><div><p>A server defined search that matches either the url or derivedFrom</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>SHOULD be valued with <code>active</code></p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div><p>Logical canonical URL to reference this SubscriptionTopic (globally unique)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><h3 id=\"rest2\">REST Configuration: 2 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode2\" class=\"panel-title\">Mode: <code>client</code></h4></div><div class=\"panel-body\"><div><p>DSUBm Resource Notification Broker provides capability to send notification</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or <a href=\"http://www.hl7.org/fhir/smart-app-launch/\">SMART-app-launch</a></p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h4 id=\"resourcesCap2\">Capabilities by Resource/Profile</h4><h5 id=\"resourcesSummary2\">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Bundle2-1\">Bundle</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-IHE.DSUBm.EventNotification.html\">Event Notification Bundle</a><br/>��<a href=\"StructureDefinition-IHE.DSUBm.HandshakeNotification.html\">Handshake Notification Bundle</a><br/>��<a href=\"StructureDefinition-IHE.DSUBm.HeartbeatNotification.html\">Heartbeat Notification Bundle</a><br/>��<a href=\"StructureDefinition-IHE.DSUBm.SubscriptionDeactivationNotification.html\">Subscription Deactivation Notification Bundle</a></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Bundle2-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Bundle</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-IHE.DSUBm.EventNotification.html\">Event Notification Bundle</a><br/><a href=\"StructureDefinition-IHE.DSUBm.HandshakeNotification.html\">Handshake Notification Bundle</a><br/><a href=\"StructureDefinition-IHE.DSUBm.HeartbeatNotification.html\">Heartbeat Notification Bundle</a><br/><a href=\"StructureDefinition-IHE.DSUBm.SubscriptionDeactivationNotification.html\">Subscription Deactivation Notification Bundle</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p><a href=\"ITI-112.html\">Resource Notify [ITI-112]</a></p>\n</div></blockquote></div></div></div></div></div></div>"
},
"url" : "https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker",
"version" : "1.0.1-current",
"name" : "IHE_DSUBm_ResourceNotificationBroker",
"title" : "IHE DSUBm ResourceNotificationBroker",
"status" : "active",
"experimental" : false,
"date" : "2023-10-27",
"publisher" : "IHE IT Infrastructure Technical Committee",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
}
]
},
{
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
},
{
"name" : "IHE IT Infrastructure Technical Committee",
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
}
],
"description" : "The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided.\n\n- Using FHIR R4\n- SHALL support both json and xml encoding\n- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)\n- SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic\n- MAY support the ITI-111 transaction\n- SHALL support the ITI-112 transaction:\n - SHALL support Handshake Notification\n - SHOULD support Heartbeat Notification\n - SHALL support Event Notification\n - SHOULD support Subscription Deactivation Notification\n- SHALL support the ITI-113 transaction: \n - SHALL support the following [Search Parameters](ITI-113.html#23113412-message-semantics)\n - _id\n - status\n - url\n - filter-criteria\n - topic\n - SHALL support the DSUBm $status operation \n - SHOULD support the DSUBm $events operation \n- SHALL support the ITI-114 transaction:\n - SHALL support the following [Search Parameters](ITI-114.html#23114412-message-semantics)\n - code\n - _id\n - resource\n - derived-or-self\n - status\n - url\n",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"documentation" : "DSUBm Resource Notification Broker provides capability to receive subscription, receive the stream of events, receive Subscription and SubscriptionTopic Resource search",
"security" : {
"description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
},
"resource" : [
{
"type" : "Subscription",
"supportedProfile" : [
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription",
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription",
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-PatientDependent-Subscription",
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-MultiPatient-Subscription"
],
"documentation" : "Resource Subscription [ITI-110](ITI-110.html) and Resource Subscription Search [ITI-113](ITI-113.html)",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"type" : "string",
"documentation" : "The id of the Subscription"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"type" : "token",
"documentation" : "The current state of the subscription"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "url",
"type" : "uri",
"documentation" : "The URI that will receive the notifications"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "filter-criteria",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-filter-criteria",
"type" : "string",
"documentation" : "This SearchParameter enables query of subscriptions by filter criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "topic",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic",
"type" : "uri",
"documentation" : "This SearchParameter enables query of subscriptions by canonical topic-url"
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "events",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events",
"documentation" : "The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle "
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status",
"documentation" : "The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle "
}
]
},
{
"type" : "Basic",
"documentation" : "Resource SubscriptionTopic Search [ITI-114](ITI-114.html):\nThe Resource Notification Broker Actor SHALL support the canonical instances of SubscriptionTopic presented in the DSUBm profile.\nSee [here](artifacts.html#canonical-subscriptiontopic)",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"type" : "token",
"documentation" : "Kind of Resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"type" : "string",
"documentation" : "The id of the SubscriptionTopic"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "resource",
"type" : "uri",
"documentation" : "Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "derived-or-self",
"type" : "uri",
"documentation" : "A server defined search that matches either the url or derivedFrom"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"type" : "token",
"documentation" : "SHOULD be valued with `active`"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "url",
"type" : "uri",
"documentation" : "Logical canonical URL to reference this SubscriptionTopic (globally unique)"
}
]
}
],
"interaction" : [
{
"code" : "transaction",
"documentation" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition-IHE.MHD.Minimal.ProvideBundle.html"
}
]
},
{
"mode" : "client",
"documentation" : "DSUBm Resource Notification Broker provides capability to send notification",
"security" : {
"description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
},
"resource" : [
{
"type" : "Bundle",
"supportedProfile" : [
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.EventNotification",
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.HandshakeNotification",
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.HeartbeatNotification",
"https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.SubscriptionDeactivationNotification"
],
"documentation" : "[Resource Notify [ITI-112]](ITI-112.html)"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.